Space - Diana & Lee #21

theomoondev · 2020-05-29T23:02:49Z

Assignment Submission: Video Store API

Congratulations! You're submitting your assignment. Please reflect on the assignment with these questions.

If you didn't get to the functionality the question is asking about, reply with what you would have done if you had completed it.

Reflection

Prompt	Response
Explain how you came up with the initial design of your ERD, based on the seed data and reading through the API endpoints	As we were reading through the expected response values from each endpoint, we thought about how they would translate into attributes and relationships between the models. When we saw that there was a `/rentals` endpoint, we deduced that this could be a bridge entity between the Customer and Video entities, and that there would be a many-to-many relationship between Customer and Video through Rentals. We checked our assumptions about entity attributes against the seed data.
What would be the Big-O time complexity of your `/customers` & `/videos` endpoints? What does the time complexity depend on? Explain your reasoning.	O(n), where n is the number of records retrieved. Our theory is that the order method retrieves the records into an array and sorts in one iteration.
What is the Big-O time complexity of the `POST /rentals/check-in` endpoint? What does the time complexity depend on? Explain your reasoning.	O(n), where n is the number of Rental records. We iterate through the Rental collection once to find the one that has the given customer_id and video_id. Our theory is that increment_counter() and decrement_counter() don't add to time complexity.
Describe a specific set of positive and negative test cases you implemented for a model.	We checked whether the program would respond as expected if all the required fields were either present, nil, or an invalid datatype.
Describe a specific set of positive and negative test cases you implemented for a controller.	We checked whether our endpoints would respond with a :success if given the required/proper params, and whether they would respond with :bad_request or :not_found when given improper params.
Broadly, describe how an API should respond when it handles a request with invalid/erroneous parameters.	It should return an errors hash with detailed error messages and a status code in the 400 range.
Describe one of your custom model methods and why you chose to wrap that functionality into a method.	The self.checkout method in the Rental model increments the given customer's videos_checked_out_count and decrements the given video's available_inventory, and updates the customer's and video's updated_at values. We chose to wrap that functionality into a method because it increases readability in the controller method. If we were required to write tests for model methods too, we could also test for more granular cases.

Customers Index Controller Action & Tests

Videos Index Controller Action and Tests

…date not string

…t' syntax

…FIELDS

…and ChangeDateFieldsToDateDatatype

…odels

…ntals#check_in action

…elds are returned for a valid rental

…ncrements available_inventory, and sets the due_date to nil

…ustomer or video does not exist

…able_inventory

… rental_data params

…ry, and update due_date logic to video model method

…s_checked_out_count is < 1

…o total_inventory

…e_inventory would exceed total_inventory

…ts to fail

…ed due_date from rental_params

…ion-tests Customer and Rental Validations Tests

Video Validations Tests

Rental Check Out Tests and Action

Rental Check In Tests and Action

jmaddox19 · 2020-06-10T21:59:52Z

Video Store API

Major Learning Goals/Code Review

Criteria	yes/no, and optionally any details/lines of code to reference
Practices git with at least 10 small commits and meaningful commit messages	✔️
Understands the importance of how APIs handle invalid/erroneous data in their reflection questions	✔️
Practices Rails best practices and well-designed separation, and encapsulates business logic around check-out and check-in in models	✔️
Uses controller tests to ensure quality code for every route, and checks for response status and content, with positive cases and negative cases	✔️
Uses controller tests to ensure correctness for `check out` and `check in` requirement, and that checked out counts and inventories appropriately change	✔️

Functional Requirements

Functional Requirement	yes/no
All provided smoke tests for Wave 1 pass	✔️
All provided smoke tests for Wave 2 pass	✔️

Overall Feedback

Overall Feedback	Criteria	yes/no
Green (Meets/Exceeds Standards)	3+ in Code Review && 2 in Functional Requirements	✔️
Yellow (Approaches Standards)	2+ in Code Review && 1+ in Functional Requirements, or the instructor judges that this project needs special attention
Red (Not at Standard)	0-1 in Code Review or 0 in Functional Reqs, or assignment is breaking/doesn’t run with less than 5 minutes of debugging, or the instructor judges that this project needs special attention

Additional Feedback

Great work! Y'all built a fully functional API!

Code Style Bonus Awards

Was the code particularly impressive in code style for any of these reasons (or more...?)

Quality	Yes?
Perfect Indentation	✅
Elegant/Clever
Descriptive/Readable	✅
Concise	✅
Logical/Organized	✅

jmaddox19 · 2020-06-10T21:55:27Z

app/controllers/rentals_controller.rb

+    end
+
+    Rental.check_out(rental.customer_id, rental.video_id)
+    # For some reason, we needed to reload the customer and video in order to get the updated counts


This is what I'd expect here. :)
You updated the values in the database but need to reload to see the new values reflected in the scope of the variables in this method.

jmaddox19 · 2020-06-10T21:56:23Z

app/controllers/rentals_controller.rb

+      return
+    else
+      render json: {
+          errors: rental.errors.messages


There's actually no chance that the request could be bad at this point because the customer_id and video_id have already been verified on line 9. Hence you don't have a unit test that verifies this case.

jmaddox19 · 2020-06-10T21:57:55Z

app/controllers/rentals_controller.rb

+    customer.reload 
+    video.reload
+
+    rental.due_date = Time.now + 7.days


Minor: This could have been nice to add to the check_out method as well

dnguye2 and others added 30 commits May 26, 2020 14:51

initial Rails setup

f5f0d74

adds Customers controller

6cb08b6

adds Customer model

d07f8c1

added Video model

272bd83

adds Rental model

ad727cb

generates migration relating customer and video to rentals

dd45d66

added migration for videos_checked_out_count for cust

b6495e8

Merge branch 'master' of https://github.com/peachmakkoli/video-store-api

3c264d0

generates migration adds available_inventory to videos

09c9135

removes duplicate column from customers and videos, migrates database

400c09e

created Videos controller

fa07780

videos index tests complete

bf7a34d

video index controller action complete

20caa72

added test for a status 200 for index when empty array

1b6c77e

adds first test for customers#index action

152d29d

adds tests checking that customers#index returns proper fields

8148bb5

defines customers#index action, gets a list of customers

cbe4463

revises test for if no customers exists, checks for 200 status

91ffddd

added 3 records for videos fixtures

30c1bf8

Merge pull request #2 from peachmakkoli/01-lh-get-customers

6452d60

Customers Index Controller Action & Tests

Merge pull request #1 from peachmakkoli/01-dn-get-videos

352608e

Videos Index Controller Action and Tests

generates migration to change release_date and due_date datatypes to …

bbb0179

…date not string

updates the change date datatype migration by implementing 'using cas…

88cd2b4

…t' syntax

generates migration for adding address, city, state to customers

22ab770

adds test for videos#show action

59be309

adds videos#show action, renders error message when id is invalid

c3ff2d4

changes VIDEO_FIELDS constant to VIDEO_INDEX_FIELDS, adds VIDEO_SHOW_…

3e7daf4

…FIELDS

completes videos#show action, renders details about specific video

b41fcff

updates schema.rb to reflect latest migrations AddColumnsToCustomers …

7ca030e

…and ChangeDateFieldsToDateDatatype

added validations for video model

b5b3a44

theomoondev and others added 28 commits May 28, 2020 17:12

adds dependent:nullify to rental relationship in customer and video m…

d63a157

…odels

creates rentals/check-in route, adds pseudocode and test cases for re…

c785f66

…ntals#check_in action

renders json for rentals#check-in action, tests whether the proper fi…

b001958

…elds are returned for a valid rental

tests whether rentals#check-in decrements videos_checked_out_count, i…

b2c9264

…ncrements available_inventory, and sets the due_date to nil

tests whether rentals#check-in returns detailed errors and a 404 if c…

7aab4da

…ustomer or video does not exist

added fixture for edge case when a checkout is requested with 0 avail…

18e0e04

…able_inventory

added check_out model method for rentals

24ecf81

fixes tests for rentals#check-in: reloads customer and video, changes…

c0f55de

… rental_data params

added rentals#checkout action

a3a91d0

added rentals#checkout action for rentals controller

fa85092

added nominal and edge case tests for rentals#checkout action

bab81df

completes rentals#check-in action

0a58915

moves decrement videos_checked_out_count, increment available_invento…

373436d

…ry, and update due_date logic to video model method

adds edge case test for if the customer videos_checked_out_count is 0

0d1d322

updates rentals#check-in so it returns an error if the customer video…

b14dd41

…s_checked_out_count is < 1

broke up validation test of checkout fields into smaller tests

1bf8ecc

reloads customer and video in after calling the rentals#check_in method

cebbef1

adds edge case test for when the video available_inventory is equal t…

099fce1

…o total_inventory

updates rentals#check-in so it returns an error if the video availabl…

e60a97a

…e_inventory would exceed total_inventory

removes edge case test for available_inventory, was causing smoke tes…

ee503c1

…ts to fail

dried up rental#checkout for video and customer validations and remov…

1dd02e4

…ed due_date from rental_params

Merge pull request #6 from peachmakkoli/03-lh-customer-rental-validat…

45751ba

…ion-tests Customer and Rental Validations Tests

Merge pull request #5 from peachmakkoli/03-dn-video-validations-tests

c0c1baa

Video Validations Tests

Merge pull request #7 from peachmakkoli/04-dn-rental-check-out

f10365a

Rental Check Out Tests and Action

Merge branch 'master' into 04-lh-rentals-check-in

59abef2

Merge pull request #8 from peachmakkoli/04-lh-rentals-check-in

40e086d

Rental Check In Tests and Action

dries up customer controller tests using check_response helper method

c5de788

changed succesful created rental from status :created to have status :ok

6844a5a

jmaddox19 reviewed Jun 10, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Space - Diana & Lee #21

Space - Diana & Lee #21

Uh oh!

theomoondev commented May 29, 2020

Uh oh!

jmaddox19 commented Jun 10, 2020

Uh oh!

jmaddox19 Jun 10, 2020

Uh oh!

jmaddox19 Jun 10, 2020

Uh oh!

jmaddox19 Jun 10, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Space - Diana & Lee #21

Are you sure you want to change the base?

Space - Diana & Lee #21

Uh oh!

Conversation

theomoondev commented May 29, 2020

Assignment Submission: Video Store API

Reflection

Uh oh!

jmaddox19 commented Jun 10, 2020

Video Store API

Major Learning Goals/Code Review

Functional Requirements

Overall Feedback

Additional Feedback

Code Style Bonus Awards

Uh oh!

jmaddox19 Jun 10, 2020

Choose a reason for hiding this comment

Uh oh!

jmaddox19 Jun 10, 2020

Choose a reason for hiding this comment

Uh oh!

jmaddox19 Jun 10, 2020

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants